libxl: add a detailed explanation of the libxl domain memory model

Originally-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com>
Converted to US-ASCII by iwj.

Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com>
Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>

diff --git a/tools/libxl/libxl_memory.txt b/tools/libxl/libxl_memory.txt
new file mode 100644 (file)
index 0000000..253476d
--- /dev/null
+++ b/tools/libxl/libxl_memory.txt
@@ -0,0 +1,70 @@
+/* === Domain memory breakdown: HVM guests ==================================
+                           
+             +  +----------+                                     +            
+             |  | shadow   |                                     |            
+             |  +----------+                                     |            
+    overhead |  | extra    |                                     |            
+             |  | external |                                     |            
+             |  +----------+                          +          |            
+             |  | extra    |                          |          |            
+             |  | internal |                          |          |            
+             +  +----------+                +         |          | footprint  
+             |  | video    |                |         |          |            
+             |  +----------+  +    +        |         | xen      |            
+             |  |          |  |    |        | actual  | maximum  |            
+             |  |          |  |    |        | target  |          |            
+             |  | guest    |  |    | build  |         |          |            
+             |  |          |  |    | start  |         |          |            
+      static |  |          |  |    |        |         |          |            
+     maximum |  +----------+  |    +        +         +          +            
+             |  |          |  |                                               
+             |  |          |  |                                               
+             |  | balloon  |  | build                                         
+             |  |          |  | maximum                                       
+             |  |          |  |                                               
+             +  +----------+  +                                               
+                
+                
+    extra internal = LIBXL_MAXMEM_CONSTANT
+    extra external = LIBXL_HVM_EXTRA_MEMORY
+    shadow = libxl_domain_build_info.shadow_memkb
+    static maximum = libxl_domain_build_info.max_memkb
+    video = libxl_domain_build_info.video_memkb
+    build start = libxl_domain_build_info.target_memkb
+    libxl_domain_setmaxmem -> xen maximum
+    libxl_set_memory_target -> actual target
+                
+                
+ === Domain memory breakdown: PV guests ==================================
+                
+                
+             +  +----------+                                     +            
+    overhead |  | extra    |                                     |            
+             |  | external |                                     |            
+             |  +----------+                          +          |            
+             |  | extra    |                          |          |            
+             |  | internal |                          |          |            
+             +  +----------+  +    +        +         |          | footprint  
+             |  |          |  |    |        |         | xen      |            
+             |  |          |  |    |        | actual  | maximum  | 
+             |  | guest    |  |    | build  | target  |          |            
+             |  |          |  |    | start  |         |          |            
+      static |  |          |  |    |        |         |          |            
+     maximum |  +----------+  |    +        +         +          +            
+             |  |          |  |                                               
+             |  |          |  |                                               
+             |  | balloon  |  | build                                         
+             |  |          |  | maximum                                       
+             |  |          |  |                                               
+             +  +----------+  +                                               
+                
+
+    extra internal = LIBXL_MAXMEM_CONSTANT
+    extra external = LIBXL_PV_EXTRA_MEMORY
+    static maximum = libxl_domain_build_info.max_memkb
+    build start = libxl_domain_build_info.target_memkb
+    libxl_domain_setmaxmem -> xen maximum
+    libxl_set_memory_target -> actual target
+
+
+ ========================================================================= */